Skip to main content

Logic Tree

Docusurus Illustration

What is Docusaurus?​

Docusaurus 2 is an open-source static site generator framework developed and maintained by Meta. It's built with React, and offers various features out-of-the-box. Some of the logic I found cumbersome, as with most React frameworks. Docusaurus does provide a nice platform that has many built in abstractions and a API plugin friendly environment that suits many.

Use Case​

I used [Docusaurus 2], for the boiler plate. From my local - I push direct to this GitHub repo. A build is triggered in Netlify—basic covering basic CI/CD processes. As a Tech writer I try to lean into becoming a better Dev: below is the website structure 😁.

Website_Directory/

├── Root/
│   ├── docusaurus.config.js
│   │── sidebar.js
│   ├── package.json
│   ├── README.md
│   │── robots.txt
│   └── package.json
│   │ 
│   ├── static/
│   │   └──img1.png
│   │   └──img2.png
│   │
│   ├── src/
│   │   └──components/ 
│   │      └──form features
│   │      └──index.js
│   │      └──styles.module.css
│   │ 
│   │   └──pages/
│   │      └──About.md
│   │      └──Contact.js
│   │ 
│   │  └──css/
│   │     ├──about.css
│   │     ├──custom.css
│   │     
│   │
└──Case-studys/
│   │   ├──Advertising/
│   │       └──Volvo.md
│   │       └──Adobe.md
│   │
│   │   └──Tech Writing/
│   │       └──Addestino.md
│   │       └──A-P-I-Docs.md
│   │ 
└── Blog/
│   ├── authors.yml/
│   │   ├── index.md
│   │   ├── infrastructure-as-code.md
│   │   └── Monitor-Aerospike-.md
│   │ 
│   │ 
└── 🏗️ Build /
ℹ️ About
📄 index.html
📁 assets
  🎨 css
  🖼️ images
  📜 js
📝 blog
📞 contact
📖 docs
  🖼️ img
  ⚖️ legal
  🎉 success
❌ .nojekyll
⚠️ 404.html
📄 index.html
🗺️ sitemap.xml


Other Frameworks​

Not exhaustive but worth mentioning.

Read the Docs: is a popular documentation hosting platform that simplifies the process of creating and publishing documentation. It supports various documentation formats, such as Sphinx, MkDocs, and Jupyter notebooks.

GitBook: is a versatile platform that allows users to create, publish, and host documentation. It supports various documentation formats, including Markdown, AsciiDoc, and reStructuredText.

Jekyll: is a popular static site generator that can be used to create documentation websites. It uses Markdown and Liquid templating to generate static HTML pages.

Conclusion​

Your choice of techstack depends on taste, and what problems your trying to solve. Next time, I need a front-end, going to play with HTMX or Svelte.